3 * Base representation for a MediaWiki page.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Abstract class for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
29 * Class representing a MediaWiki article and history.
31 * Some fields are public only for backwards-compatibility. Use accessors.
32 * In the past, this class was part of Article.php and everything was public.
34 * @internal documentation reviewed 15 Mar 2010
36 class WikiPage
implements Page
, IDBAccessObject
{
37 // Constants for $mDataLoadedFrom and related
42 public $mTitle = null;
47 public $mDataLoaded = false; // !< Boolean
48 public $mIsRedirect = false; // !< Boolean
49 public $mLatest = false; // !< Integer (false means "not loaded")
50 public $mPreparedEdit = false; // !< Array
56 protected $mId = null;
59 * @var int; one of the READ_* constants
61 protected $mDataLoadedFrom = self
::READ_NONE
;
66 protected $mRedirectTarget = null;
71 protected $mLastRevision = null;
74 * @var string; timestamp of the current revision or empty string if not loaded
76 protected $mTimestamp = '';
81 protected $mTouched = '19700101000000';
86 protected $mCounter = null;
89 * Constructor and clear the article
90 * @param $title Title Reference to a Title object.
92 public function __construct( Title
$title ) {
93 $this->mTitle
= $title;
97 * Create a WikiPage object of the appropriate class for the given title.
100 * @throws MWException
101 * @return WikiPage object of the appropriate type
103 public static function factory( Title
$title ) {
104 $ns = $title->getNamespace();
106 if ( $ns == NS_MEDIA
) {
107 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
108 } elseif ( $ns < 0 ) {
109 throw new MWException( "Invalid or virtual namespace $ns given." );
114 $page = new WikiFilePage( $title );
117 $page = new WikiCategoryPage( $title );
120 $page = new WikiPage( $title );
127 * Constructor from a page id
129 * @param int $id article ID to load
130 * @param string|int $from one of the following values:
131 * - "fromdb" or WikiPage::READ_NORMAL to select from a slave database
132 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
134 * @return WikiPage|null
136 public static function newFromID( $id, $from = 'fromdb' ) {
137 $from = self
::convertSelectType( $from );
138 $db = wfGetDB( $from === self
::READ_LATEST ? DB_MASTER
: DB_SLAVE
);
139 $row = $db->selectRow( 'page', self
::selectFields(), array( 'page_id' => $id ), __METHOD__
);
143 return self
::newFromRow( $row, $from );
147 * Constructor from a database row
150 * @param $row object: database row containing at least fields returned
152 * @param string|int $from source of $data:
153 * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB
154 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
155 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
158 public static function newFromRow( $row, $from = 'fromdb' ) {
159 $page = self
::factory( Title
::newFromRow( $row ) );
160 $page->loadFromRow( $row, $from );
165 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
167 * @param $type object|string|int
170 private static function convertSelectType( $type ) {
173 return self
::READ_NORMAL
;
175 return self
::READ_LATEST
;
177 return self
::READ_LOCKING
;
179 // It may already be an integer or whatever else
185 * Returns overrides for action handlers.
186 * Classes listed here will be used instead of the default one when
187 * (and only when) $wgActions[$action] === true. This allows subclasses
188 * to override the default behavior.
190 * @todo Move this UI stuff somewhere else
194 public function getActionOverrides() {
195 $content_handler = $this->getContentHandler();
196 return $content_handler->getActionOverrides();
200 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
202 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
204 * @return ContentHandler
208 public function getContentHandler() {
209 return ContentHandler
::getForModelID( $this->getContentModel() );
213 * Get the title object of the article
214 * @return Title object of this page
216 public function getTitle() {
217 return $this->mTitle
;
224 public function clear() {
225 $this->mDataLoaded
= false;
226 $this->mDataLoadedFrom
= self
::READ_NONE
;
228 $this->clearCacheFields();
232 * Clear the object cache fields
235 protected function clearCacheFields() {
237 $this->mCounter
= null;
238 $this->mRedirectTarget
= null; // Title object if set
239 $this->mLastRevision
= null; // Latest revision
240 $this->mTouched
= '19700101000000';
241 $this->mTimestamp
= '';
242 $this->mIsRedirect
= false;
243 $this->mLatest
= false;
244 $this->mPreparedEdit
= false;
248 * Return the list of revision fields that should be selected to create
253 public static function selectFields() {
254 global $wgContentHandlerUseDB;
270 if ( $wgContentHandlerUseDB ) {
271 $fields[] = 'page_content_model';
278 * Fetch a page record with the given conditions
279 * @param $dbr DatabaseBase object
280 * @param $conditions Array
281 * @param $options Array
282 * @return mixed Database result resource, or false on failure
284 protected function pageData( $dbr, $conditions, $options = array() ) {
285 $fields = self
::selectFields();
287 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
289 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
, $options );
291 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
297 * Fetch a page record matching the Title object's namespace and title
298 * using a sanitized title string
300 * @param $dbr DatabaseBase object
301 * @param $title Title object
302 * @param $options Array
303 * @return mixed Database result resource, or false on failure
305 public function pageDataFromTitle( $dbr, $title, $options = array() ) {
306 return $this->pageData( $dbr, array(
307 'page_namespace' => $title->getNamespace(),
308 'page_title' => $title->getDBkey() ), $options );
312 * Fetch a page record matching the requested ID
314 * @param $dbr DatabaseBase
316 * @param $options Array
317 * @return mixed Database result resource, or false on failure
319 public function pageDataFromId( $dbr, $id, $options = array() ) {
320 return $this->pageData( $dbr, array( 'page_id' => $id ), $options );
324 * Set the general counter, title etc data loaded from
327 * @param $from object|string|int One of the following:
328 * - A DB query result object
329 * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB
330 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB
331 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB using SELECT FOR UPDATE
335 public function loadPageData( $from = 'fromdb' ) {
336 $from = self
::convertSelectType( $from );
337 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
338 // We already have the data from the correct location, no need to load it twice.
342 if ( $from === self
::READ_LOCKING
) {
343 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
, array( 'FOR UPDATE' ) );
344 } elseif ( $from === self
::READ_LATEST
) {
345 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
);
346 } elseif ( $from === self
::READ_NORMAL
) {
347 $data = $this->pageDataFromTitle( wfGetDB( DB_SLAVE
), $this->mTitle
);
348 // Use a "last rev inserted" timestamp key to diminish the issue of slave lag.
349 // Note that DB also stores the master position in the session and checks it.
350 $touched = $this->getCachedLastEditTime();
351 if ( $touched ) { // key set
352 if ( !$data ||
$touched > wfTimestamp( TS_MW
, $data->page_touched
) ) {
353 $from = self
::READ_LATEST
;
354 $data = $this->pageDataFromTitle( wfGetDB( DB_MASTER
), $this->mTitle
);
358 // No idea from where the caller got this data, assume slave database.
360 $from = self
::READ_NORMAL
;
363 $this->loadFromRow( $data, $from );
367 * Load the object from a database row
370 * @param $data object: database row containing at least fields returned
372 * @param string|int $from One of the following:
373 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB
374 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
375 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from from
376 * the master DB using SELECT FOR UPDATE
378 public function loadFromRow( $data, $from ) {
379 $lc = LinkCache
::singleton();
380 $lc->clearLink( $this->mTitle
);
383 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
385 $this->mTitle
->loadFromRow( $data );
387 // Old-fashioned restrictions
388 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
390 $this->mId
= intval( $data->page_id
);
391 $this->mCounter
= intval( $data->page_counter
);
392 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
393 $this->mIsRedirect
= intval( $data->page_is_redirect
);
394 $this->mLatest
= intval( $data->page_latest
);
395 // Bug 37225: $latest may no longer match the cached latest Revision object.
396 // Double-check the ID of any cached latest Revision object for consistency.
397 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
398 $this->mLastRevision
= null;
399 $this->mTimestamp
= '';
402 $lc->addBadLinkObj( $this->mTitle
);
404 $this->mTitle
->loadFromRow( false );
406 $this->clearCacheFields();
411 $this->mDataLoaded
= true;
412 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
416 * @return int Page ID
418 public function getId() {
419 if ( !$this->mDataLoaded
) {
420 $this->loadPageData();
426 * @return bool Whether or not the page exists in the database
428 public function exists() {
429 if ( !$this->mDataLoaded
) {
430 $this->loadPageData();
432 return $this->mId
> 0;
436 * Check if this page is something we're going to be showing
437 * some sort of sensible content for. If we return false, page
438 * views (plain action=view) will return an HTTP 404 response,
439 * so spiders and robots can know they're following a bad link.
443 public function hasViewableContent() {
444 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
448 * @return int The view count for the page
450 public function getCount() {
451 if ( !$this->mDataLoaded
) {
452 $this->loadPageData();
455 return $this->mCounter
;
459 * Tests if the article content represents a redirect
463 public function isRedirect() {
464 $content = $this->getContent();
469 return $content->isRedirect();
473 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
475 * Will use the revisions actual content model if the page exists,
476 * and the page's default if the page doesn't exist yet.
482 public function getContentModel() {
483 if ( $this->exists() ) {
484 // look at the revision's actual content model
485 $rev = $this->getRevision();
487 if ( $rev !== null ) {
488 return $rev->getContentModel();
490 $title = $this->mTitle
->getPrefixedDBkey();
491 wfWarn( "Page $title exists but has no (visible) revisions!" );
495 // use the default model for this page
496 return $this->mTitle
->getContentModel();
500 * Loads page_touched and returns a value indicating if it should be used
501 * @return boolean true if not a redirect
503 public function checkTouched() {
504 if ( !$this->mDataLoaded
) {
505 $this->loadPageData();
507 return !$this->mIsRedirect
;
511 * Get the page_touched field
512 * @return string containing GMT timestamp
514 public function getTouched() {
515 if ( !$this->mDataLoaded
) {
516 $this->loadPageData();
518 return $this->mTouched
;
522 * Get the page_latest field
523 * @return integer rev_id of current revision
525 public function getLatest() {
526 if ( !$this->mDataLoaded
) {
527 $this->loadPageData();
529 return (int)$this->mLatest
;
533 * Get the Revision object of the oldest revision
534 * @return Revision|null
536 public function getOldestRevision() {
537 wfProfileIn( __METHOD__
);
539 // Try using the slave database first, then try the master
541 $db = wfGetDB( DB_SLAVE
);
542 $revSelectFields = Revision
::selectFields();
544 while ( $continue ) {
545 $row = $db->selectRow(
546 array( 'page', 'revision' ),
549 'page_namespace' => $this->mTitle
->getNamespace(),
550 'page_title' => $this->mTitle
->getDBkey(),
555 'ORDER BY' => 'rev_timestamp ASC'
562 $db = wfGetDB( DB_MASTER
);
567 wfProfileOut( __METHOD__
);
568 return $row ? Revision
::newFromRow( $row ) : null;
572 * Loads everything except the text
573 * This isn't necessary for all uses, so it's only done if needed.
575 protected function loadLastEdit() {
576 if ( $this->mLastRevision
!== null ) {
577 return; // already loaded
580 $latest = $this->getLatest();
582 return; // page doesn't exist or is missing page_latest info
585 // Bug 37225: if session S1 loads the page row FOR UPDATE, the result always includes the
586 // latest changes committed. This is true even within REPEATABLE-READ transactions, where
587 // S1 normally only sees changes committed before the first S1 SELECT. Thus we need S1 to
588 // also gets the revision row FOR UPDATE; otherwise, it may not find it since a page row
589 // UPDATE and revision row INSERT by S2 may have happened after the first S1 SELECT.
590 // http://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read.
591 $flags = ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) ? Revision
::READ_LOCKING
: 0;
592 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
593 if ( $revision ) { // sanity
594 $this->setLastEdit( $revision );
599 * Set the latest revision
601 protected function setLastEdit( Revision
$revision ) {
602 $this->mLastRevision
= $revision;
603 $this->mTimestamp
= $revision->getTimestamp();
607 * Get the latest revision
608 * @return Revision|null
610 public function getRevision() {
611 $this->loadLastEdit();
612 if ( $this->mLastRevision
) {
613 return $this->mLastRevision
;
619 * Get the content of the current revision. No side-effects...
621 * @param $audience Integer: one of:
622 * Revision::FOR_PUBLIC to be displayed to all users
623 * Revision::FOR_THIS_USER to be displayed to $wgUser
624 * Revision::RAW get the text regardless of permissions
625 * @param $user User object to check for, only if FOR_THIS_USER is passed
626 * to the $audience parameter
627 * @return Content|null The content of the current revision
631 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
632 $this->loadLastEdit();
633 if ( $this->mLastRevision
) {
634 return $this->mLastRevision
->getContent( $audience, $user );
640 * Get the text of the current revision. No side-effects...
642 * @param $audience Integer: one of:
643 * Revision::FOR_PUBLIC to be displayed to all users
644 * Revision::FOR_THIS_USER to be displayed to the given user
645 * Revision::RAW get the text regardless of permissions
646 * @param $user User object to check for, only if FOR_THIS_USER is passed
647 * to the $audience parameter
648 * @return String|false The text of the current revision
649 * @deprecated as of 1.21, getContent() should be used instead.
651 public function getText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) { // @todo deprecated, replace usage!
652 ContentHandler
::deprecated( __METHOD__
, '1.21' );
654 $this->loadLastEdit();
655 if ( $this->mLastRevision
) {
656 return $this->mLastRevision
->getText( $audience, $user );
662 * Get the text of the current revision. No side-effects...
664 * @return String|bool The text of the current revision. False on failure
665 * @deprecated as of 1.21, getContent() should be used instead.
667 public function getRawText() {
668 ContentHandler
::deprecated( __METHOD__
, '1.21' );
670 return $this->getText( Revision
::RAW
);
674 * @return string MW timestamp of last article revision
676 public function getTimestamp() {
677 // Check if the field has been filled by WikiPage::setTimestamp()
678 if ( !$this->mTimestamp
) {
679 $this->loadLastEdit();
682 return wfTimestamp( TS_MW
, $this->mTimestamp
);
686 * Set the page timestamp (use only to avoid DB queries)
687 * @param string $ts MW timestamp of last article revision
690 public function setTimestamp( $ts ) {
691 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
695 * @param $audience Integer: one of:
696 * Revision::FOR_PUBLIC to be displayed to all users
697 * Revision::FOR_THIS_USER to be displayed to the given user
698 * Revision::RAW get the text regardless of permissions
699 * @param $user User object to check for, only if FOR_THIS_USER is passed
700 * to the $audience parameter
701 * @return int user ID for the user that made the last article revision
703 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
704 $this->loadLastEdit();
705 if ( $this->mLastRevision
) {
706 return $this->mLastRevision
->getUser( $audience, $user );
713 * Get the User object of the user who created the page
714 * @param $audience Integer: one of:
715 * Revision::FOR_PUBLIC to be displayed to all users
716 * Revision::FOR_THIS_USER to be displayed to the given user
717 * Revision::RAW get the text regardless of permissions
718 * @param $user User object to check for, only if FOR_THIS_USER is passed
719 * to the $audience parameter
722 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
723 $revision = $this->getOldestRevision();
725 $userName = $revision->getUserText( $audience, $user );
726 return User
::newFromName( $userName, false );
733 * @param $audience Integer: one of:
734 * Revision::FOR_PUBLIC to be displayed to all users
735 * Revision::FOR_THIS_USER to be displayed to the given user
736 * Revision::RAW get the text regardless of permissions
737 * @param $user User object to check for, only if FOR_THIS_USER is passed
738 * to the $audience parameter
739 * @return string username of the user that made the last article revision
741 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
742 $this->loadLastEdit();
743 if ( $this->mLastRevision
) {
744 return $this->mLastRevision
->getUserText( $audience, $user );
751 * @param $audience Integer: one of:
752 * Revision::FOR_PUBLIC to be displayed to all users
753 * Revision::FOR_THIS_USER to be displayed to the given user
754 * Revision::RAW get the text regardless of permissions
755 * @param $user User object to check for, only if FOR_THIS_USER is passed
756 * to the $audience parameter
757 * @return string Comment stored for the last article revision
759 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
760 $this->loadLastEdit();
761 if ( $this->mLastRevision
) {
762 return $this->mLastRevision
->getComment( $audience, $user );
769 * Returns true if last revision was marked as "minor edit"
771 * @return boolean Minor edit indicator for the last article revision.
773 public function getMinorEdit() {
774 $this->loadLastEdit();
775 if ( $this->mLastRevision
) {
776 return $this->mLastRevision
->isMinor();
783 * Get the cached timestamp for the last time the page changed.
784 * This is only used to help handle slave lag by comparing to page_touched.
785 * @return string MW timestamp
787 protected function getCachedLastEditTime() {
789 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle
->getPrefixedDBkey() ) );
790 return $wgMemc->get( $key );
794 * Set the cached timestamp for the last time the page changed.
795 * This is only used to help handle slave lag by comparing to page_touched.
796 * @param $timestamp string
799 public function setCachedLastEditTime( $timestamp ) {
801 $key = wfMemcKey( 'page-lastedit', md5( $this->mTitle
->getPrefixedDBkey() ) );
802 $wgMemc->set( $key, wfTimestamp( TS_MW
, $timestamp ), 60 * 15 );
806 * Determine whether a page would be suitable for being counted as an
807 * article in the site_stats table based on the title & its content
809 * @param $editInfo Object|bool (false): object returned by prepareTextForEdit(),
810 * if false, the current database state will be used
813 public function isCountable( $editInfo = false ) {
814 global $wgArticleCountMethod;
816 if ( !$this->mTitle
->isContentPage() ) {
821 $content = $editInfo->pstContent
;
823 $content = $this->getContent();
826 if ( !$content ||
$content->isRedirect() ) {
832 if ( $wgArticleCountMethod === 'link' ) {
833 // nasty special case to avoid re-parsing to detect links
836 // ParserOutput::getLinks() is a 2D array of page links, so
837 // to be really correct we would need to recurse in the array
838 // but the main array should only have items in it if there are
840 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
842 $hasLinks = (bool)wfGetDB( DB_SLAVE
)->selectField( 'pagelinks', 1,
843 array( 'pl_from' => $this->getId() ), __METHOD__
);
847 return $content->isCountable( $hasLinks );
851 * If this page is a redirect, get its target
853 * The target will be fetched from the redirect table if possible.
854 * If this page doesn't have an entry there, call insertRedirect()
855 * @return Title|mixed object, or null if this page is not a redirect
857 public function getRedirectTarget() {
858 if ( !$this->mTitle
->isRedirect() ) {
862 if ( $this->mRedirectTarget
!== null ) {
863 return $this->mRedirectTarget
;
866 // Query the redirect table
867 $dbr = wfGetDB( DB_SLAVE
);
868 $row = $dbr->selectRow( 'redirect',
869 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
870 array( 'rd_from' => $this->getId() ),
874 // rd_fragment and rd_interwiki were added later, populate them if empty
875 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
876 return $this->mRedirectTarget
= Title
::makeTitle(
877 $row->rd_namespace
, $row->rd_title
,
878 $row->rd_fragment
, $row->rd_interwiki
);
881 // This page doesn't have an entry in the redirect table
882 return $this->mRedirectTarget
= $this->insertRedirect();
886 * Insert an entry for this page into the redirect table.
888 * Don't call this function directly unless you know what you're doing.
889 * @return Title object or null if not a redirect
891 public function insertRedirect() {
892 // recurse through to only get the final target
893 $content = $this->getContent();
894 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
898 $this->insertRedirectEntry( $retval );
903 * Insert or update the redirect table entry for this page to indicate
904 * it redirects to $rt .
905 * @param $rt Title redirect target
907 public function insertRedirectEntry( $rt ) {
908 $dbw = wfGetDB( DB_MASTER
);
909 $dbw->replace( 'redirect', array( 'rd_from' ),
911 'rd_from' => $this->getId(),
912 'rd_namespace' => $rt->getNamespace(),
913 'rd_title' => $rt->getDBkey(),
914 'rd_fragment' => $rt->getFragment(),
915 'rd_interwiki' => $rt->getInterwiki(),
922 * Get the Title object or URL this page redirects to
924 * @return mixed false, Title of in-wiki target, or string with URL
926 public function followRedirect() {
927 return $this->getRedirectURL( $this->getRedirectTarget() );
931 * Get the Title object or URL to use for a redirect. We use Title
932 * objects for same-wiki, non-special redirects and URLs for everything
934 * @param $rt Title Redirect target
935 * @return mixed false, Title object of local target, or string with URL
937 public function getRedirectURL( $rt ) {
942 if ( $rt->isExternal() ) {
943 if ( $rt->isLocal() ) {
944 // Offsite wikis need an HTTP redirect.
946 // This can be hard to reverse and may produce loops,
947 // so they may be disabled in the site configuration.
948 $source = $this->mTitle
->getFullURL( 'redirect=no' );
949 return $rt->getFullURL( array( 'rdfrom' => $source ) );
951 // External pages pages without "local" bit set are not valid
957 if ( $rt->isSpecialPage() ) {
958 // Gotta handle redirects to special pages differently:
959 // Fill the HTTP response "Location" header and ignore
960 // the rest of the page we're on.
962 // Some pages are not valid targets
963 if ( $rt->isValidRedirectTarget() ) {
964 return $rt->getFullURL();
974 * Get a list of users who have edited this article, not including the user who made
975 * the most recent revision, which you can get from $article->getUser() if you want it
976 * @return UserArrayFromResult
978 public function getContributors() {
979 // @todo FIXME: This is expensive; cache this info somewhere.
981 $dbr = wfGetDB( DB_SLAVE
);
983 if ( $dbr->implicitGroupby() ) {
984 $realNameField = 'user_real_name';
986 $realNameField = 'MIN(user_real_name) AS user_real_name';
989 $tables = array( 'revision', 'user' );
992 'user_id' => 'rev_user',
993 'user_name' => 'rev_user_text',
995 'timestamp' => 'MAX(rev_timestamp)',
998 $conds = array( 'rev_page' => $this->getId() );
1000 // The user who made the top revision gets credited as "this page was last edited by
1001 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1002 $user = $this->getUser();
1004 $conds[] = "rev_user != $user";
1006 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1009 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
1012 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
1016 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
1017 'ORDER BY' => 'timestamp DESC',
1020 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1021 return new UserArrayFromResult( $res );
1025 * Get the last N authors
1026 * @param $num Integer: number of revisions to get
1027 * @param string $revLatest the latest rev_id, selected from the master (optional)
1028 * @return array Array of authors, duplicates not removed
1030 public function getLastNAuthors( $num, $revLatest = 0 ) {
1031 wfProfileIn( __METHOD__
);
1032 // First try the slave
1033 // If that doesn't have the latest revision, try the master
1035 $db = wfGetDB( DB_SLAVE
);
1038 $res = $db->select( array( 'page', 'revision' ),
1039 array( 'rev_id', 'rev_user_text' ),
1041 'page_namespace' => $this->mTitle
->getNamespace(),
1042 'page_title' => $this->mTitle
->getDBkey(),
1043 'rev_page = page_id'
1046 'ORDER BY' => 'rev_timestamp DESC',
1052 wfProfileOut( __METHOD__
);
1056 $row = $db->fetchObject( $res );
1058 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
1059 $db = wfGetDB( DB_MASTER
);
1064 } while ( $continue );
1066 $authors = array( $row->rev_user_text
);
1068 foreach ( $res as $row ) {
1069 $authors[] = $row->rev_user_text
;
1072 wfProfileOut( __METHOD__
);
1077 * Should the parser cache be used?
1079 * @param $parserOptions ParserOptions to check
1083 public function isParserCacheUsed( ParserOptions
$parserOptions, $oldid ) {
1084 global $wgEnableParserCache;
1086 return $wgEnableParserCache
1087 && $parserOptions->getStubThreshold() == 0
1089 && ( $oldid === null ||
$oldid === 0 ||
$oldid === $this->getLatest() )
1090 && $this->getContentHandler()->isParserCacheSupported();
1094 * Get a ParserOutput for the given ParserOptions and revision ID.
1095 * The parser cache will be used if possible.
1098 * @param $parserOptions ParserOptions to use for the parse operation
1099 * @param $oldid Revision ID to get the text from, passing null or 0 will
1100 * get the current revision (default value)
1102 * @return ParserOutput or false if the revision was not found
1104 public function getParserOutput( ParserOptions
$parserOptions, $oldid = null ) {
1105 wfProfileIn( __METHOD__
);
1107 $useParserCache = $this->isParserCacheUsed( $parserOptions, $oldid );
1108 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1109 if ( $parserOptions->getStubThreshold() ) {
1110 wfIncrStats( 'pcache_miss_stub' );
1113 if ( $useParserCache ) {
1114 $parserOutput = ParserCache
::singleton()->get( $this, $parserOptions );
1115 if ( $parserOutput !== false ) {
1116 wfProfileOut( __METHOD__
);
1117 return $parserOutput;
1121 if ( $oldid === null ||
$oldid === 0 ) {
1122 $oldid = $this->getLatest();
1125 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1128 wfProfileOut( __METHOD__
);
1130 return $pool->getParserOutput();
1134 * Do standard deferred updates after page view
1135 * @param $user User The relevant user
1137 public function doViewUpdates( User
$user ) {
1138 global $wgDisableCounters;
1139 if ( wfReadOnly() ) {
1143 // Don't update page view counters on views from bot users (bug 14044)
1144 if ( !$wgDisableCounters && !$user->isAllowed( 'bot' ) && $this->exists() ) {
1145 DeferredUpdates
::addUpdate( new ViewCountUpdate( $this->getId() ) );
1146 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 1, 0, 0 ) );
1149 // Update newtalk / watchlist notification status
1150 $user->clearNotification( $this->mTitle
);
1154 * Perform the actions of a page purging
1157 public function doPurge() {
1160 if ( !wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1164 // Invalidate the cache
1165 $this->mTitle
->invalidateCache();
1167 if ( $wgUseSquid ) {
1168 // Commit the transaction before the purge is sent
1169 $dbw = wfGetDB( DB_MASTER
);
1170 $dbw->commit( __METHOD__
);
1173 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1174 $update->doUpdate();
1177 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1178 // @todo move this logic to MessageCache
1180 if ( $this->exists() ) {
1181 // NOTE: use transclusion text for messages.
1182 // This is consistent with MessageCache::getMsgFromNamespace()
1184 $content = $this->getContent();
1185 $text = $content === null ?
null : $content->getWikitextForTransclusion();
1187 if ( $text === null ) {
1194 MessageCache
::singleton()->replace( $this->mTitle
->getDBkey(), $text );
1200 * Insert a new empty page record for this article.
1201 * This *must* be followed up by creating a revision
1202 * and running $this->updateRevisionOn( ... );
1203 * or else the record will be left in a funky state.
1204 * Best if all done inside a transaction.
1206 * @param $dbw DatabaseBase
1207 * @return int The newly created page_id key, or false if the title already existed
1209 public function insertOn( $dbw ) {
1210 wfProfileIn( __METHOD__
);
1212 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1213 $dbw->insert( 'page', array(
1214 'page_id' => $page_id,
1215 'page_namespace' => $this->mTitle
->getNamespace(),
1216 'page_title' => $this->mTitle
->getDBkey(),
1217 'page_counter' => 0,
1218 'page_restrictions' => '',
1219 'page_is_redirect' => 0, // Will set this shortly...
1221 'page_random' => wfRandom(),
1222 'page_touched' => $dbw->timestamp(),
1223 'page_latest' => 0, // Fill this in shortly...
1224 'page_len' => 0, // Fill this in shortly...
1225 ), __METHOD__
, 'IGNORE' );
1227 $affected = $dbw->affectedRows();
1230 $newid = $dbw->insertId();
1231 $this->mId
= $newid;
1232 $this->mTitle
->resetArticleID( $newid );
1234 wfProfileOut( __METHOD__
);
1236 return $affected ?
$newid : false;
1240 * Update the page record to point to a newly saved revision.
1242 * @param $dbw DatabaseBase: object
1243 * @param $revision Revision: For ID number, and text used to set
1244 * length and redirect status fields
1245 * @param $lastRevision Integer: if given, will not overwrite the page field
1246 * when different from the currently set value.
1247 * Giving 0 indicates the new page flag should be set
1249 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1250 * removing rows in redirect table.
1251 * @return bool true on success, false on failure
1254 public function updateRevisionOn( $dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null ) {
1255 global $wgContentHandlerUseDB;
1257 wfProfileIn( __METHOD__
);
1259 $content = $revision->getContent();
1260 $len = $content ?
$content->getSize() : 0;
1261 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1263 $conditions = array( 'page_id' => $this->getId() );
1265 if ( !is_null( $lastRevision ) ) {
1266 // An extra check against threads stepping on each other
1267 $conditions['page_latest'] = $lastRevision;
1270 $now = wfTimestampNow();
1271 $row = array( /* SET */
1272 'page_latest' => $revision->getId(),
1273 'page_touched' => $dbw->timestamp( $now ),
1274 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1275 'page_is_redirect' => $rt !== null ?
1 : 0,
1279 if ( $wgContentHandlerUseDB ) {
1280 $row['page_content_model'] = $revision->getContentModel();
1283 $dbw->update( 'page',
1288 $result = $dbw->affectedRows() > 0;
1290 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1291 $this->setLastEdit( $revision );
1292 $this->setCachedLastEditTime( $now );
1293 $this->mLatest
= $revision->getId();
1294 $this->mIsRedirect
= (bool)$rt;
1295 // Update the LinkCache.
1296 LinkCache
::singleton()->addGoodLinkObj( $this->getId(), $this->mTitle
, $len, $this->mIsRedirect
,
1297 $this->mLatest
, $revision->getContentModel() );
1300 wfProfileOut( __METHOD__
);
1305 * Add row to the redirect table if this is a redirect, remove otherwise.
1307 * @param $dbw DatabaseBase
1308 * @param $redirectTitle Title object pointing to the redirect target,
1309 * or NULL if this is not a redirect
1310 * @param $lastRevIsRedirect null|bool If given, will optimize adding and
1311 * removing rows in redirect table.
1312 * @return bool true on success, false on failure
1315 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1316 // Always update redirects (target link might have changed)
1317 // Update/Insert if we don't know if the last revision was a redirect or not
1318 // Delete if changing from redirect to non-redirect
1319 $isRedirect = !is_null( $redirectTitle );
1321 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1325 wfProfileIn( __METHOD__
);
1326 if ( $isRedirect ) {
1327 $this->insertRedirectEntry( $redirectTitle );
1329 // This is not a redirect, remove row from redirect table
1330 $where = array( 'rd_from' => $this->getId() );
1331 $dbw->delete( 'redirect', $where, __METHOD__
);
1334 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1335 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1337 wfProfileOut( __METHOD__
);
1339 return ( $dbw->affectedRows() != 0 );
1343 * If the given revision is newer than the currently set page_latest,
1344 * update the page record. Otherwise, do nothing.
1346 * @param $dbw DatabaseBase object
1347 * @param $revision Revision object
1350 public function updateIfNewerOn( $dbw, $revision ) {
1351 wfProfileIn( __METHOD__
);
1353 $row = $dbw->selectRow(
1354 array( 'revision', 'page' ),
1355 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1357 'page_id' => $this->getId(),
1358 'page_latest=rev_id' ),
1362 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1363 wfProfileOut( __METHOD__
);
1366 $prev = $row->rev_id
;
1367 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1369 // No or missing previous revision; mark the page as new
1371 $lastRevIsRedirect = null;
1374 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1376 wfProfileOut( __METHOD__
);
1381 * Get the content that needs to be saved in order to undo all revisions
1382 * between $undo and $undoafter. Revisions must belong to the same page,
1383 * must exist and must not be deleted
1384 * @param $undo Revision
1385 * @param $undoafter Revision Must be an earlier revision than $undo
1386 * @return mixed string on success, false on failure
1388 * Before we had the Content object, this was done in getUndoText
1390 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1391 $handler = $undo->getContentHandler();
1392 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1396 * Get the text that needs to be saved in order to undo all revisions
1397 * between $undo and $undoafter. Revisions must belong to the same page,
1398 * must exist and must not be deleted
1399 * @param $undo Revision
1400 * @param $undoafter Revision Must be an earlier revision than $undo
1401 * @return mixed string on success, false on failure
1402 * @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
1404 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
1405 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1407 $this->loadLastEdit();
1409 if ( $this->mLastRevision
) {
1410 if ( is_null( $undoafter ) ) {
1411 $undoafter = $undo->getPrevious();
1414 $handler = $this->getContentHandler();
1415 $undone = $handler->getUndoContent( $this->mLastRevision
, $undo, $undoafter );
1420 return ContentHandler
::getContentText( $undone );
1428 * @param $section null|bool|int or a section number (0, 1, 2, T1, T2...)
1429 * @param string $text new text of the section
1430 * @param string $sectionTitle new section's subject, only if $section is 'new'
1431 * @param string $edittime revision timestamp or null to use the current revision
1432 * @throws MWException
1433 * @return String new complete article text, or null if error
1435 * @deprecated since 1.21, use replaceSectionContent() instead
1437 public function replaceSection( $section, $text, $sectionTitle = '', $edittime = null ) {
1438 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1440 if ( strval( $section ) == '' ) { //NOTE: keep condition in sync with condition in replaceSectionContent!
1441 // Whole-page edit; let the whole text through
1445 if ( !$this->supportsSections() ) {
1446 throw new MWException( "sections not supported for content model " . $this->getContentHandler()->getModelID() );
1449 // could even make section title, but that's not required.
1450 $sectionContent = ContentHandler
::makeContent( $text, $this->getTitle() );
1452 $newContent = $this->replaceSectionContent( $section, $sectionContent, $sectionTitle, $edittime );
1454 return ContentHandler
::getContentText( $newContent );
1458 * Returns true iff this page's content model supports sections.
1460 * @return boolean whether sections are supported.
1462 * @todo The skin should check this and not offer section functionality if sections are not supported.
1463 * @todo The EditPage should check this and not offer section functionality if sections are not supported.
1465 public function supportsSections() {
1466 return $this->getContentHandler()->supportsSections();
1470 * @param $section null|bool|int or a section number (0, 1, 2, T1, T2...)
1471 * @param $sectionContent Content: new content of the section
1472 * @param string $sectionTitle new section's subject, only if $section is 'new'
1473 * @param string $edittime revision timestamp or null to use the current revision
1475 * @throws MWException
1476 * @return Content new complete article content, or null if error
1480 public function replaceSectionContent( $section, Content
$sectionContent, $sectionTitle = '', $edittime = null ) {
1481 wfProfileIn( __METHOD__
);
1483 if ( strval( $section ) == '' ) {
1484 // Whole-page edit; let the whole text through
1485 $newContent = $sectionContent;
1487 if ( !$this->supportsSections() ) {
1488 wfProfileOut( __METHOD__
);
1489 throw new MWException( "sections not supported for content model " . $this->getContentHandler()->getModelID() );
1492 // Bug 30711: always use current version when adding a new section
1493 if ( is_null( $edittime ) ||
$section == 'new' ) {
1494 $oldContent = $this->getContent();
1496 $dbw = wfGetDB( DB_MASTER
);
1497 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1500 wfDebug( "WikiPage::replaceSection asked for bogus section (page: " .
1501 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1502 wfProfileOut( __METHOD__
);
1506 $oldContent = $rev->getContent();
1509 if ( ! $oldContent ) {
1510 wfDebug( __METHOD__
. ": no page text\n" );
1511 wfProfileOut( __METHOD__
);
1515 // FIXME: $oldContent might be null?
1516 $newContent = $oldContent->replaceSection( $section, $sectionContent, $sectionTitle );
1519 wfProfileOut( __METHOD__
);
1524 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1526 * @return Int updated $flags
1528 function checkFlags( $flags ) {
1529 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1530 if ( $this->exists() ) {
1531 $flags |
= EDIT_UPDATE
;
1541 * Change an existing article or create a new article. Updates RC and all necessary caches,
1542 * optionally via the deferred update array.
1544 * @param string $text new text
1545 * @param string $summary edit summary
1546 * @param $flags Integer bitfield:
1548 * Article is known or assumed to be non-existent, create a new one
1550 * Article is known or assumed to be pre-existing, update it
1552 * Mark this edit minor, if the user is allowed to do so
1554 * Do not log the change in recentchanges
1556 * Mark the edit a "bot" edit regardless of user rights
1557 * EDIT_DEFER_UPDATES
1558 * Defer some of the updates until the end of index.php
1560 * Fill in blank summaries with generated text where possible
1562 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1563 * If EDIT_UPDATE is specified and the article doesn't exist, the function will return an
1564 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1565 * edit-already-exists error will be returned. These two conditions are also possible with
1566 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1568 * @param bool|int $baseRevId int the revision ID this edit was based off, if any
1569 * @param $user User the user doing the edit
1571 * @throws MWException
1572 * @return Status object. Possible errors:
1573 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1574 * edit-gone-missing: In update mode, but the article didn't exist
1575 * edit-conflict: In update mode, the article changed unexpectedly
1576 * edit-no-change: Warning that the text was the same as before
1577 * edit-already-exists: In creation mode, but the article already exists
1579 * Extensions may define additional errors.
1581 * $return->value will contain an associative array with members as follows:
1582 * new: Boolean indicating if the function attempted to create a new article
1583 * revision: The revision object for the inserted revision, or null
1585 * Compatibility note: this function previously returned a boolean value indicating success/failure
1587 * @deprecated since 1.21: use doEditContent() instead.
1589 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1590 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1592 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
1594 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1598 * Change an existing article or create a new article. Updates RC and all necessary caches,
1599 * optionally via the deferred update array.
1601 * @param $content Content: new content
1602 * @param string $summary edit summary
1603 * @param $flags Integer bitfield:
1605 * Article is known or assumed to be non-existent, create a new one
1607 * Article is known or assumed to be pre-existing, update it
1609 * Mark this edit minor, if the user is allowed to do so
1611 * Do not log the change in recentchanges
1613 * Mark the edit a "bot" edit regardless of user rights
1614 * EDIT_DEFER_UPDATES
1615 * Defer some of the updates until the end of index.php
1617 * Fill in blank summaries with generated text where possible
1619 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1620 * If EDIT_UPDATE is specified and the article doesn't exist, the function will return an
1621 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1622 * edit-already-exists error will be returned. These two conditions are also possible with
1623 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1625 * @param bool|\the $baseRevId the revision ID this edit was based off, if any
1626 * @param $user User the user doing the edit
1627 * @param $serialisation_format String: format for storing the content in the database
1629 * @throws MWException
1630 * @return Status object. Possible errors:
1631 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1632 * edit-gone-missing: In update mode, but the article didn't exist
1633 * edit-conflict: In update mode, the article changed unexpectedly
1634 * edit-no-change: Warning that the text was the same as before
1635 * edit-already-exists: In creation mode, but the article already exists
1637 * Extensions may define additional errors.
1639 * $return->value will contain an associative array with members as follows:
1640 * new: Boolean indicating if the function attempted to create a new article
1641 * revision: The revision object for the inserted revision, or null
1645 public function doEditContent( Content
$content, $summary, $flags = 0, $baseRevId = false,
1646 User
$user = null, $serialisation_format = null ) {
1647 global $wgUser, $wgUseAutomaticEditSummaries, $wgUseRCPatrol, $wgUseNPPatrol;
1649 // Low-level sanity check
1650 if ( $this->mTitle
->getText() === '' ) {
1651 throw new MWException( 'Something is trying to edit an article with an empty title' );
1654 wfProfileIn( __METHOD__
);
1656 if ( !$content->getContentHandler()->canBeUsedOn( $this->getTitle() ) ) {
1657 wfProfileOut( __METHOD__
);
1658 return Status
::newFatal( 'content-not-allowed-here',
1659 ContentHandler
::getLocalizedName( $content->getModel() ),
1660 $this->getTitle()->getPrefixedText() );
1663 $user = is_null( $user ) ?
$wgUser : $user;
1664 $status = Status
::newGood( array() );
1666 // Load the data from the master database if needed.
1667 // The caller may already loaded it from the master or even loaded it using
1668 // SELECT FOR UPDATE, so do not override that using clear().
1669 $this->loadPageData( 'fromdbmaster' );
1671 $flags = $this->checkFlags( $flags );
1674 $hook_args = array( &$this, &$user, &$content, &$summary,
1675 $flags & EDIT_MINOR
, null, null, &$flags, &$status );
1677 if ( !wfRunHooks( 'PageContentSave', $hook_args )
1678 ||
!ContentHandler
::runLegacyHooks( 'ArticleSave', $hook_args ) ) {
1680 wfDebug( __METHOD__
. ": ArticleSave or ArticleSaveContent hook aborted save!\n" );
1682 if ( $status->isOK() ) {
1683 $status->fatal( 'edit-hook-aborted' );
1686 wfProfileOut( __METHOD__
);
1690 // Silently ignore EDIT_MINOR if not allowed
1691 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
1692 $bot = $flags & EDIT_FORCE_BOT
;
1694 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1696 $oldsize = $old_content ?
$old_content->getSize() : 0;
1697 $oldid = $this->getLatest();
1698 $oldIsRedirect = $this->isRedirect();
1699 $oldcountable = $this->isCountable();
1701 $handler = $content->getContentHandler();
1703 // Provide autosummaries if one is not provided and autosummaries are enabled.
1704 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
1705 if ( !$old_content ) {
1706 $old_content = null;
1708 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1711 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialisation_format );
1712 $serialized = $editInfo->pst
;
1713 $content = $editInfo->pstContent
;
1714 $newsize = $content->getSize();
1716 $dbw = wfGetDB( DB_MASTER
);
1717 $now = wfTimestampNow();
1718 $this->mTimestamp
= $now;
1720 if ( $flags & EDIT_UPDATE
) {
1721 // Update article, but only if changed.
1722 $status->value
['new'] = false;
1725 // Article gone missing
1726 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
1727 $status->fatal( 'edit-gone-missing' );
1729 wfProfileOut( __METHOD__
);
1731 } elseif ( !$old_content ) {
1732 // Sanity check for bug 37225
1733 wfProfileOut( __METHOD__
);
1734 throw new MWException( "Could not find text for current revision {$oldid}." );
1737 $revision = new Revision( array(
1738 'page' => $this->getId(),
1739 'title' => $this->getTitle(), // for determining the default content model
1740 'comment' => $summary,
1741 'minor_edit' => $isminor,
1742 'text' => $serialized,
1744 'parent_id' => $oldid,
1745 'user' => $user->getId(),
1746 'user_text' => $user->getName(),
1747 'timestamp' => $now,
1748 'content_model' => $content->getModel(),
1749 'content_format' => $serialisation_format,
1750 ) ); // XXX: pass content object?!
1752 $changed = !$content->equals( $old_content );
1755 if ( !$content->isValid() ) {
1756 wfProfileOut( __METHOD__
);
1757 throw new MWException( "New content failed validity check!" );
1760 $dbw->begin( __METHOD__
);
1762 $prepStatus = $content->prepareSave( $this, $flags, $baseRevId, $user );
1763 $status->merge( $prepStatus );
1765 if ( !$status->isOK() ) {
1766 $dbw->rollback( __METHOD__
);
1768 wfProfileOut( __METHOD__
);
1772 $revisionId = $revision->insertOn( $dbw );
1776 // Note that we use $this->mLatest instead of fetching a value from the master DB
1777 // during the course of this function. This makes sure that EditPage can detect
1778 // edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
1779 // before this function is called. A previous function used a separate query, this
1780 // creates a window where concurrent edits can cause an ignored edit conflict.
1781 $ok = $this->updateRevisionOn( $dbw, $revision, $oldid, $oldIsRedirect );
1784 // Belated edit conflict! Run away!!
1785 $status->fatal( 'edit-conflict' );
1787 $dbw->rollback( __METHOD__
);
1789 wfProfileOut( __METHOD__
);
1793 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
1794 // Update recentchanges
1795 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1796 // Mark as patrolled if the user can do so
1797 $patrolled = $wgUseRCPatrol && !count(
1798 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1799 // Add RC row to the DB
1800 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
1801 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1802 $revisionId, $patrolled
1805 // Log auto-patrolled edits
1807 PatrolLog
::record( $rc, true, $user );
1810 $user->incEditCount();
1811 $dbw->commit( __METHOD__
);
1813 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1814 // related variables correctly
1815 $revision->setId( $this->getLatest() );
1818 // Update links tables, site stats, etc.
1819 $this->doEditUpdates(
1823 'changed' => $changed,
1824 'oldcountable' => $oldcountable
1829 $status->warning( 'edit-no-change' );
1831 // Update page_touched, this is usually implicit in the page update
1832 // Other cache updates are done in onArticleEdit()
1833 $this->mTitle
->invalidateCache();
1836 // Create new article
1837 $status->value
['new'] = true;
1839 $dbw->begin( __METHOD__
);
1841 $prepStatus = $content->prepareSave( $this, $flags, $baseRevId, $user );
1842 $status->merge( $prepStatus );
1844 if ( !$status->isOK() ) {
1845 $dbw->rollback( __METHOD__
);
1847 wfProfileOut( __METHOD__
);
1851 $status->merge( $prepStatus );
1853 // Add the page record; stake our claim on this title!
1854 // This will return false if the article already exists
1855 $newid = $this->insertOn( $dbw );
1857 if ( $newid === false ) {
1858 $dbw->rollback( __METHOD__
);
1859 $status->fatal( 'edit-already-exists' );
1861 wfProfileOut( __METHOD__
);
1865 // Save the revision text...
1866 $revision = new Revision( array(
1868 'title' => $this->getTitle(), // for determining the default content model
1869 'comment' => $summary,
1870 'minor_edit' => $isminor,
1871 'text' => $serialized,
1873 'user' => $user->getId(),
1874 'user_text' => $user->getName(),
1875 'timestamp' => $now,
1876 'content_model' => $content->getModel(),
1877 'content_format' => $serialisation_format,
1879 $revisionId = $revision->insertOn( $dbw );
1881 // Bug 37225: use accessor to get the text as Revision may trim it
1882 $content = $revision->getContent(); // sanity; get normalized version
1885 $newsize = $content->getSize();
1888 // Update the page record with revision data
1889 $this->updateRevisionOn( $dbw, $revision, 0 );
1891 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1893 // Update recentchanges
1894 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1895 // Mark as patrolled if the user can do so
1896 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && !count(
1897 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1898 // Add RC row to the DB
1899 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
1900 '', $newsize, $revisionId, $patrolled );
1902 // Log auto-patrolled edits
1904 PatrolLog
::record( $rc, true, $user );
1907 $user->incEditCount();
1908 $dbw->commit( __METHOD__
);
1910 // Update links, etc.
1911 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
1913 $hook_args = array( &$this, &$user, $content, $summary,
1914 $flags & EDIT_MINOR
, null, null, &$flags, $revision );
1916 ContentHandler
::runLegacyHooks( 'ArticleInsertComplete', $hook_args );
1917 wfRunHooks( 'PageContentInsertComplete', $hook_args );
1920 // Do updates right now unless deferral was requested
1921 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
1922 DeferredUpdates
::doUpdates();
1925 // Return the new revision (or null) to the caller
1926 $status->value
['revision'] = $revision;
1928 $hook_args = array( &$this, &$user, $content, $summary,
1929 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId );
1931 ContentHandler
::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
1932 wfRunHooks( 'PageContentSaveComplete', $hook_args );
1934 // Promote user to any groups they meet the criteria for
1935 $user->addAutopromoteOnceGroups( 'onEdit' );
1937 wfProfileOut( __METHOD__
);
1942 * Get parser options suitable for rendering the primary article wikitext
1944 * @see ContentHandler::makeParserOptions
1946 * @param IContextSource|User|string $context One of the following:
1947 * - IContextSource: Use the User and the Language of the provided
1949 * - User: Use the provided User object and $wgLang for the language,
1950 * so use an IContextSource object if possible.
1951 * - 'canonical': Canonical options (anonymous user with default
1952 * preferences and content language).
1953 * @return ParserOptions
1955 public function makeParserOptions( $context ) {
1956 $options = $this->getContentHandler()->makeParserOptions( $context );
1958 if ( $this->getTitle()->isConversionTable() ) {
1959 // @todo ConversionTable should become a separate content model, so we don't need special cases like this one.
1960 $options->disableContentConversion();
1967 * Prepare text which is about to be saved.
1968 * Returns a stdclass with source, pst and output members
1970 * @deprecated in 1.21: use prepareContentForEdit instead.
1972 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
1973 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1974 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
1975 return $this->prepareContentForEdit( $content, $revid, $user );
1979 * Prepare content which is about to be saved.
1980 * Returns a stdclass with source, pst and output members
1982 * @param \Content $content
1983 * @param null $revid
1984 * @param null|\User $user
1985 * @param null $serialization_format
1987 * @return bool|object
1991 public function prepareContentForEdit( Content
$content, $revid = null, User
$user = null, $serialization_format = null ) {
1992 global $wgContLang, $wgUser;
1993 $user = is_null( $user ) ?
$wgUser : $user;
1994 //XXX: check $user->getId() here???
1996 if ( $this->mPreparedEdit
1997 && $this->mPreparedEdit
->newContent
1998 && $this->mPreparedEdit
->newContent
->equals( $content )
1999 && $this->mPreparedEdit
->revid
== $revid
2000 && $this->mPreparedEdit
->format
== $serialization_format
2001 // XXX: also check $user here?
2004 return $this->mPreparedEdit
;
2007 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2008 wfRunHooks( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2010 $edit = (object)array();
2011 $edit->revid
= $revid;
2013 $edit->pstContent
= $content ?
$content->preSaveTransform( $this->mTitle
, $user, $popts ) : null;
2015 $edit->format
= $serialization_format;
2016 $edit->popts
= $this->makeParserOptions( 'canonical' );
2017 $edit->output
= $edit->pstContent ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
) : null;
2019 $edit->newContent
= $content;
2020 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2022 // NOTE: B/C for hooks! don't use these fields!
2023 $edit->newText
= $edit->newContent ? ContentHandler
::getContentText( $edit->newContent
) : '';
2024 $edit->oldText
= $edit->oldContent ? ContentHandler
::getContentText( $edit->oldContent
) : '';
2025 $edit->pst
= $edit->pstContent ?
$edit->pstContent
->serialize( $serialization_format ) : '';
2027 $this->mPreparedEdit
= $edit;
2032 * Do standard deferred updates after page edit.
2033 * Update links tables, site stats, search index and message cache.
2034 * Purges pages that include this page if the text was changed here.
2035 * Every 100th edit, prune the recent changes table.
2037 * @param $revision Revision object
2038 * @param $user User object that did the revision
2039 * @param array $options of options, following indexes are used:
2040 * - changed: boolean, whether the revision changed the content (default true)
2041 * - created: boolean, whether the revision created the page (default false)
2042 * - oldcountable: boolean or null (default null):
2043 * - boolean: whether the page was counted as an article before that
2044 * revision, only used in changed is true and created is false
2045 * - null: don't change the article count
2047 public function doEditUpdates( Revision
$revision, User
$user, array $options = array() ) {
2048 global $wgEnableParserCache;
2050 wfProfileIn( __METHOD__
);
2052 $options +
= array( 'changed' => true, 'created' => false, 'oldcountable' => null );
2053 $content = $revision->getContent();
2056 // Be careful not to do pre-save transform twice: $text is usually
2057 // already pre-save transformed once.
2058 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2059 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
2060 $editInfo = $this->prepareContentForEdit( $content, $revision->getId(), $user );
2062 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
2063 $editInfo = $this->mPreparedEdit
;
2066 // Save it to the parser cache
2067 if ( $wgEnableParserCache ) {
2068 $parserCache = ParserCache
::singleton();
2069 $parserCache->save( $editInfo->output
, $this, $editInfo->popts
);
2072 // Update the links tables and other secondary data
2074 $recursive = $options['changed']; // bug 50785
2075 $updates = $content->getSecondaryDataUpdates(
2076 $this->getTitle(), null, $recursive, $editInfo->output
);
2077 DataUpdate
::runUpdates( $updates );
2080 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2082 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2083 if ( 0 == mt_rand( 0, 99 ) ) {
2084 // Flush old entries from the `recentchanges` table; we do this on
2085 // random requests so as to avoid an increase in writes for no good reason
2086 RecentChange
::purgeExpiredChanges();
2090 if ( !$this->exists() ) {
2091 wfProfileOut( __METHOD__
);
2095 $id = $this->getId();
2096 $title = $this->mTitle
->getPrefixedDBkey();
2097 $shortTitle = $this->mTitle
->getDBkey();
2099 if ( !$options['changed'] ) {
2102 } elseif ( $options['created'] ) {
2103 $good = (int)$this->isCountable( $editInfo );
2105 } elseif ( $options['oldcountable'] !== null ) {
2106 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2113 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, $good, $total ) );
2114 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2116 // If this is another user's talk page, update newtalk.
2117 // Don't do this if $options['changed'] = false (null-edits) nor if
2118 // it's a minor edit and the user doesn't want notifications for those.
2119 if ( $options['changed']
2120 && $this->mTitle
->getNamespace() == NS_USER_TALK
2121 && $shortTitle != $user->getTitleKey()
2122 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2124 $recipient = User
::newFromName( $shortTitle, false );
2125 if ( !$recipient ) {
2126 wfDebug( __METHOD__
. ": invalid username\n" );
2128 // Allow extensions to prevent user notification when a new message is added to their talk page
2129 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this, $recipient ) ) ) {
2130 if ( User
::isIP( $shortTitle ) ) {
2131 // An anonymous user
2132 $recipient->setNewtalk( true, $revision );
2133 } elseif ( $recipient->isLoggedIn() ) {
2134 $recipient->setNewtalk( true, $revision );
2136 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2142 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2143 // XXX: could skip pseudo-messages like js/css here, based on content model.
2144 $msgtext = $content ?
$content->getWikitextForTransclusion() : null;
2145 if ( $msgtext === false ||
$msgtext === null ) {
2149 MessageCache
::singleton()->replace( $shortTitle, $msgtext );
2152 if ( $options['created'] ) {
2153 self
::onArticleCreate( $this->mTitle
);
2155 self
::onArticleEdit( $this->mTitle
);
2158 wfProfileOut( __METHOD__
);
2162 * Edit an article without doing all that other stuff
2163 * The article must already exist; link tables etc
2164 * are not updated, caches are not flushed.
2166 * @param string $text text submitted
2167 * @param $user User The relevant user
2168 * @param string $comment comment submitted
2169 * @param $minor Boolean: whereas it's a minor modification
2171 * @deprecated since 1.21, use doEditContent() instead.
2173 public function doQuickEdit( $text, User
$user, $comment = '', $minor = 0 ) {
2174 ContentHandler
::deprecated( __METHOD__
, "1.21" );
2176 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
2177 return $this->doQuickEditContent( $content, $user, $comment, $minor );
2181 * Edit an article without doing all that other stuff
2182 * The article must already exist; link tables etc
2183 * are not updated, caches are not flushed.
2185 * @param $content Content: content submitted
2186 * @param $user User The relevant user
2187 * @param string $comment comment submitted
2188 * @param $serialisation_format String: format for storing the content in the database
2189 * @param $minor Boolean: whereas it's a minor modification
2191 public function doQuickEditContent( Content
$content, User
$user, $comment = '', $minor = 0, $serialisation_format = null ) {
2192 wfProfileIn( __METHOD__
);
2194 $serialized = $content->serialize( $serialisation_format );
2196 $dbw = wfGetDB( DB_MASTER
);
2197 $revision = new Revision( array(
2198 'title' => $this->getTitle(), // for determining the default content model
2199 'page' => $this->getId(),
2200 'text' => $serialized,
2201 'length' => $content->getSize(),
2202 'comment' => $comment,
2203 'minor_edit' => $minor ?
1 : 0,
2204 ) ); // XXX: set the content object?
2205 $revision->insertOn( $dbw );
2206 $this->updateRevisionOn( $dbw, $revision );
2208 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2210 wfProfileOut( __METHOD__
);
2214 * Update the article's restriction field, and leave a log entry.
2215 * This works for protection both existing and non-existing pages.
2217 * @param array $limit set of restriction keys
2218 * @param array $expiry per restriction type expiration
2219 * @param int &$cascade Set to false if cascading protection isn't allowed.
2220 * @param string $reason
2221 * @param User $user The user updating the restrictions
2224 public function doUpdateRestrictions( array $limit, array $expiry, &$cascade, $reason, User
$user ) {
2225 global $wgCascadingRestrictionLevels;
2227 if ( wfReadOnly() ) {
2228 return Status
::newFatal( 'readonlytext', wfReadOnlyReason() );
2231 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2233 $id = $this->getId();
2239 // Take this opportunity to purge out expired restrictions
2240 Title
::purgeExpiredRestrictions();
2242 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2243 // we expect a single selection, but the schema allows otherwise.
2244 $isProtected = false;
2248 $dbw = wfGetDB( DB_MASTER
);
2250 foreach ( $restrictionTypes as $action ) {
2251 if ( !isset( $expiry[$action] ) ) {
2252 $expiry[$action] = $dbw->getInfinity();
2254 if ( !isset( $limit[$action] ) ) {
2255 $limit[$action] = '';
2256 } elseif ( $limit[$action] != '' ) {
2260 // Get current restrictions on $action
2261 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2262 if ( $current != '' ) {
2263 $isProtected = true;
2266 if ( $limit[$action] != $current ) {
2268 } elseif ( $limit[$action] != '' ) {
2269 // Only check expiry change if the action is actually being
2270 // protected, since expiry does nothing on an not-protected
2272 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2278 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2282 // If nothing has changed, do nothing
2284 return Status
::newGood();
2287 if ( !$protect ) { // No protection at all means unprotection
2288 $revCommentMsg = 'unprotectedarticle';
2289 $logAction = 'unprotect';
2290 } elseif ( $isProtected ) {
2291 $revCommentMsg = 'modifiedarticleprotection';
2292 $logAction = 'modify';
2294 $revCommentMsg = 'protectedarticle';
2295 $logAction = 'protect';
2298 if ( $id ) { // Protection of existing page
2299 if ( !wfRunHooks( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
2300 return Status
::newGood();
2303 // Only certain restrictions can cascade...
2304 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2305 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2306 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2308 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2309 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2312 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2313 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2314 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2316 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2317 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2320 // The schema allows multiple restrictions
2321 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2325 // insert null revision to identify the page protection change as edit summary
2326 $latest = $this->getLatest();
2327 $nullRevision = $this->insertProtectNullRevision( $revCommentMsg, $limit, $expiry, $cascade, $reason );
2328 if ( $nullRevision === null ) {
2329 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2332 // Update restrictions table
2333 foreach ( $limit as $action => $restrictions ) {
2334 if ( $restrictions != '' ) {
2335 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2336 array( 'pr_page' => $id,
2337 'pr_type' => $action,
2338 'pr_level' => $restrictions,
2339 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2340 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2345 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2346 'pr_type' => $action ), __METHOD__
);
2350 // Clear out legacy restriction fields
2353 array( 'page_restrictions' => '' ),
2354 array( 'page_id' => $id ),
2358 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $user ) );
2359 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2360 } else { // Protection of non-existing page (also known as "title protection")
2361 // Cascade protection is meaningless in this case
2364 if ( $limit['create'] != '' ) {
2365 $dbw->replace( 'protected_titles',
2366 array( array( 'pt_namespace', 'pt_title' ) ),
2368 'pt_namespace' => $this->mTitle
->getNamespace(),
2369 'pt_title' => $this->mTitle
->getDBkey(),
2370 'pt_create_perm' => $limit['create'],
2371 'pt_timestamp' => $dbw->encodeExpiry( wfTimestampNow() ),
2372 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2373 'pt_user' => $user->getId(),
2374 'pt_reason' => $reason,
2378 $dbw->delete( 'protected_titles',
2380 'pt_namespace' => $this->mTitle
->getNamespace(),
2381 'pt_title' => $this->mTitle
->getDBkey()
2387 $this->mTitle
->flushRestrictions();
2388 InfoAction
::invalidateCache( $this->mTitle
);
2390 if ( $logAction == 'unprotect' ) {
2393 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2394 $params = array( $protectDescriptionLog, $cascade ?
'cascade' : '' );
2397 // Update the protection log
2398 $log = new LogPage( 'protect' );
2399 $log->addEntry( $logAction, $this->mTitle
, trim( $reason ), $params, $user );
2401 return Status
::newGood();
2405 * Insert a new null revision for this page.
2407 * @param string $revCommentMsg comment message key for the revision
2408 * @param array $limit set of restriction keys
2409 * @param array $expiry per restriction type expiration
2410 * @param int $cascade Set to false if cascading protection isn't allowed.
2411 * @param string $reason
2412 * @return Revision|null on error
2414 public function insertProtectNullRevision( $revCommentMsg, array $limit, array $expiry, $cascade, $reason ) {
2416 $dbw = wfGetDB( DB_MASTER
);
2418 // Prepare a null revision to be added to the history
2419 $editComment = $wgContLang->ucfirst(
2422 $this->mTitle
->getPrefixedText()
2423 )->inContentLanguage()->text()
2426 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2428 $protectDescription = $this->protectDescription( $limit, $expiry );
2429 if ( $protectDescription ) {
2430 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2431 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )->inContentLanguage()->text();
2434 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2435 $editComment .= wfMessage( 'brackets' )->params(
2436 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2437 )->inContentLanguage()->text();
2440 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true );
2442 $nullRev->insertOn( $dbw );
2444 // Update page record and touch page
2445 $oldLatest = $nullRev->getParentId();
2446 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2453 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2456 protected function formatExpiry( $expiry ) {
2458 $dbr = wfGetDB( DB_SLAVE
);
2460 $encodedExpiry = $dbr->encodeExpiry( $expiry );
2461 if ( $encodedExpiry != 'infinity' ) {
2464 $wgContLang->timeanddate( $expiry, false, false ),
2465 $wgContLang->date( $expiry, false, false ),
2466 $wgContLang->time( $expiry, false, false )
2467 )->inContentLanguage()->text();
2469 return wfMessage( 'protect-expiry-indefinite' )
2470 ->inContentLanguage()->text();
2475 * Builds the description to serve as comment for the edit.
2477 * @param array $limit set of restriction keys
2478 * @param array $expiry per restriction type expiration
2481 public function protectDescription( array $limit, array $expiry ) {
2482 $protectDescription = '';
2484 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2485 # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2486 # All possible message keys are listed here for easier grepping:
2487 # * restriction-create
2488 # * restriction-edit
2489 # * restriction-move
2490 # * restriction-upload
2491 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2492 # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2493 # with '' filtered out. All possible message keys are listed below:
2494 # * protect-level-autoconfirmed
2495 # * protect-level-sysop
2496 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )->inContentLanguage()->text();
2498 $expiryText = $this->formatExpiry( $expiry[$action] );
2500 if ( $protectDescription !== '' ) {
2501 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2503 $protectDescription .= wfMessage( 'protect-summary-desc' )
2504 ->params( $actionText, $restrictionsText, $expiryText )
2505 ->inContentLanguage()->text();
2508 return $protectDescription;
2512 * Builds the description to serve as comment for the log entry.
2514 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2515 * protect description text. Keep them in old format to avoid breaking compatibility.
2516 * TODO: Fix protection log to store structured description and format it on-the-fly.
2518 * @param array $limit set of restriction keys
2519 * @param array $expiry per restriction type expiration
2522 public function protectDescriptionLog( array $limit, array $expiry ) {
2525 $protectDescriptionLog = '';
2527 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2528 $expiryText = $this->formatExpiry( $expiry[$action] );
2529 $protectDescriptionLog .= $wgContLang->getDirMark() . "[$action=$restrictions] ($expiryText)";
2532 return trim( $protectDescriptionLog );
2536 * Take an array of page restrictions and flatten it to a string
2537 * suitable for insertion into the page_restrictions field.
2538 * @param $limit Array
2539 * @throws MWException
2542 protected static function flattenRestrictions( $limit ) {
2543 if ( !is_array( $limit ) ) {
2544 throw new MWException( 'WikiPage::flattenRestrictions given non-array restriction set' );
2550 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2551 $bits[] = "$action=$restrictions";
2554 return implode( ':', $bits );
2558 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2559 * backwards compatibility, if you care about error reporting you should use
2560 * doDeleteArticleReal() instead.
2562 * Deletes the article with database consistency, writes logs, purges caches
2564 * @param string $reason delete reason for deletion log
2565 * @param $suppress boolean suppress all revisions and log the deletion in
2566 * the suppression log instead of the deletion log
2567 * @param int $id article ID
2568 * @param $commit boolean defaults to true, triggers transaction end
2569 * @param &$error Array of errors to append to
2570 * @param $user User The deleting user
2571 * @return boolean true if successful
2573 public function doDeleteArticle(
2574 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User
$user = null
2576 $status = $this->doDeleteArticleReal( $reason, $suppress, $id, $commit, $error, $user );
2577 return $status->isGood();
2581 * Back-end article deletion
2582 * Deletes the article with database consistency, writes logs, purges caches
2586 * @param string $reason delete reason for deletion log
2587 * @param $suppress boolean suppress all revisions and log the deletion in
2588 * the suppression log instead of the deletion log
2589 * @param int $id article ID
2590 * @param $commit boolean defaults to true, triggers transaction end
2591 * @param &$error Array of errors to append to
2592 * @param $user User The deleting user
2593 * @return Status: Status object; if successful, $status->value is the log_id of the
2594 * deletion log entry. If the page couldn't be deleted because it wasn't
2595 * found, $status is a non-fatal 'cannotdelete' error
2597 public function doDeleteArticleReal(
2598 $reason, $suppress = false, $id = 0, $commit = true, &$error = '', User
$user = null
2600 global $wgUser, $wgContentHandlerUseDB;
2602 wfDebug( __METHOD__
. "\n" );
2604 $status = Status
::newGood();
2606 if ( $this->mTitle
->getDBkey() === '' ) {
2607 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2611 $user = is_null( $user ) ?
$wgUser : $user;
2612 if ( ! wfRunHooks( 'ArticleDelete', array( &$this, &$user, &$reason, &$error, &$status ) ) ) {
2613 if ( $status->isOK() ) {
2614 // Hook aborted but didn't set a fatal status
2615 $status->fatal( 'delete-hook-aborted' );
2621 $this->loadPageData( 'forupdate' );
2622 $id = $this->getID();
2624 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2629 // Bitfields to further suppress the content
2632 // This should be 15...
2633 $bitfield |
= Revision
::DELETED_TEXT
;
2634 $bitfield |
= Revision
::DELETED_COMMENT
;
2635 $bitfield |
= Revision
::DELETED_USER
;
2636 $bitfield |
= Revision
::DELETED_RESTRICTED
;
2638 $bitfield = 'rev_deleted';
2641 // we need to remember the old content so we can use it to generate all deletion updates.
2642 $content = $this->getContent( Revision
::RAW
);
2644 $dbw = wfGetDB( DB_MASTER
);
2645 $dbw->begin( __METHOD__
);
2646 // For now, shunt the revision data into the archive table.
2647 // Text is *not* removed from the text table; bulk storage
2648 // is left intact to avoid breaking block-compression or
2649 // immutable storage schemes.
2651 // For backwards compatibility, note that some older archive
2652 // table entries will have ar_text and ar_flags fields still.
2654 // In the future, we may keep revisions and mark them with
2655 // the rev_deleted field, which is reserved for this purpose.
2658 'ar_namespace' => 'page_namespace',
2659 'ar_title' => 'page_title',
2660 'ar_comment' => 'rev_comment',
2661 'ar_user' => 'rev_user',
2662 'ar_user_text' => 'rev_user_text',
2663 'ar_timestamp' => 'rev_timestamp',
2664 'ar_minor_edit' => 'rev_minor_edit',
2665 'ar_rev_id' => 'rev_id',
2666 'ar_parent_id' => 'rev_parent_id',
2667 'ar_text_id' => 'rev_text_id',
2668 'ar_text' => '\'\'', // Be explicit to appease
2669 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2670 'ar_len' => 'rev_len',
2671 'ar_page_id' => 'page_id',
2672 'ar_deleted' => $bitfield,
2673 'ar_sha1' => 'rev_sha1',
2676 if ( $wgContentHandlerUseDB ) {
2677 $row['ar_content_model'] = 'rev_content_model';
2678 $row['ar_content_format'] = 'rev_content_format';
2681 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2685 'page_id = rev_page'
2689 // Now that it's safely backed up, delete it
2690 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
2691 $ok = ( $dbw->affectedRows() > 0 ); // $id could be laggy
2694 $dbw->rollback( __METHOD__
);
2695 $status->error( 'cannotdelete', wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2699 $this->doDeleteUpdates( $id, $content );
2701 // Log the deletion, if the page was suppressed, log it at Oversight instead
2702 $logtype = $suppress ?
'suppress' : 'delete';
2704 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2705 $logEntry->setPerformer( $user );
2706 $logEntry->setTarget( $this->mTitle
);
2707 $logEntry->setComment( $reason );
2708 $logid = $logEntry->insert();
2709 $logEntry->publish( $logid );
2712 $dbw->commit( __METHOD__
);
2715 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$user, $reason, $id, $content, $logEntry ) );
2716 $status->value
= $logid;
2721 * Do some database updates after deletion
2723 * @param int $id page_id value of the page being deleted
2724 * @param $content Content: optional page content to be used when determining the required updates.
2725 * This may be needed because $this->getContent() may already return null when the page proper was deleted.
2727 public function doDeleteUpdates( $id, Content
$content = null ) {
2728 // update site status
2729 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
2731 // remove secondary indexes, etc
2732 $updates = $this->getDeletionUpdates( $content );
2733 DataUpdate
::runUpdates( $updates );
2736 WikiPage
::onArticleDelete( $this->mTitle
);
2738 // Reset this object and the Title object
2739 $this->loadFromRow( false, self
::READ_LATEST
);
2742 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
2746 * Roll back the most recent consecutive set of edits to a page
2747 * from the same user; fails if there are no eligible edits to
2748 * roll back to, e.g. user is the sole contributor. This function
2749 * performs permissions checks on $user, then calls commitRollback()
2750 * to do the dirty work
2752 * @todo Separate the business/permission stuff out from backend code
2754 * @param string $fromP Name of the user whose edits to rollback.
2755 * @param string $summary Custom summary. Set to default summary if empty.
2756 * @param string $token Rollback token.
2757 * @param $bot Boolean: If true, mark all reverted edits as bot.
2759 * @param array $resultDetails contains result-specific array of additional values
2760 * 'alreadyrolled' : 'current' (rev)
2761 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2763 * @param $user User The user performing the rollback
2764 * @return array of errors, each error formatted as
2765 * array(messagekey, param1, param2, ...).
2766 * On success, the array is empty. This array can also be passed to
2767 * OutputPage::showPermissionsErrorPage().
2769 public function doRollback(
2770 $fromP, $summary, $token, $bot, &$resultDetails, User
$user
2772 $resultDetails = null;
2774 // Check permissions
2775 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
2776 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
2777 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
2779 if ( !$user->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
2780 $errors[] = array( 'sessionfailure' );
2783 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
2784 $errors[] = array( 'actionthrottledtext' );
2787 // If there were errors, bail out now
2788 if ( !empty( $errors ) ) {
2792 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
2796 * Backend implementation of doRollback(), please refer there for parameter
2797 * and return value documentation
2799 * NOTE: This function does NOT check ANY permissions, it just commits the
2800 * rollback to the DB. Therefore, you should only call this function direct-
2801 * ly if you want to use custom permissions checks. If you don't, use
2802 * doRollback() instead.
2803 * @param string $fromP Name of the user whose edits to rollback.
2804 * @param string $summary Custom summary. Set to default summary if empty.
2805 * @param $bot Boolean: If true, mark all reverted edits as bot.
2807 * @param array $resultDetails contains result-specific array of additional values
2808 * @param $guser User The user performing the rollback
2811 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User
$guser ) {
2812 global $wgUseRCPatrol, $wgContLang;
2814 $dbw = wfGetDB( DB_MASTER
);
2816 if ( wfReadOnly() ) {
2817 return array( array( 'readonlytext' ) );
2820 // Get the last editor
2821 $current = $this->getRevision();
2822 if ( is_null( $current ) ) {
2823 // Something wrong... no page?
2824 return array( array( 'notanarticle' ) );
2827 $from = str_replace( '_', ' ', $fromP );
2828 // User name given should match up with the top revision.
2829 // If the user was deleted then $from should be empty.
2830 if ( $from != $current->getUserText() ) {
2831 $resultDetails = array( 'current' => $current );
2832 return array( array( 'alreadyrolled',
2833 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
2834 htmlspecialchars( $fromP ),
2835 htmlspecialchars( $current->getUserText() )
2839 // Get the last edit not by this guy...
2840 // Note: these may not be public values
2841 $user = intval( $current->getRawUser() );
2842 $user_text = $dbw->addQuotes( $current->getRawUserText() );
2843 $s = $dbw->selectRow( 'revision',
2844 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
2845 array( 'rev_page' => $current->getPage(),
2846 "rev_user != {$user} OR rev_user_text != {$user_text}"
2848 array( 'USE INDEX' => 'page_timestamp',
2849 'ORDER BY' => 'rev_timestamp DESC' )
2851 if ( $s === false ) {
2852 // No one else ever edited this page
2853 return array( array( 'cantrollback' ) );
2854 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
2855 // Only admins can see this text
2856 return array( array( 'notvisiblerev' ) );
2860 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
2861 // Mark all reverted edits as bot
2865 if ( $wgUseRCPatrol ) {
2866 // Mark all reverted edits as patrolled
2867 $set['rc_patrolled'] = 1;
2870 if ( count( $set ) ) {
2871 $dbw->update( 'recentchanges', $set,
2873 'rc_cur_id' => $current->getPage(),
2874 'rc_user_text' => $current->getUserText(),
2875 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
2880 // Generate the edit summary if necessary
2881 $target = Revision
::newFromId( $s->rev_id
);
2882 if ( empty( $summary ) ) {
2883 if ( $from == '' ) { // no public user name
2884 $summary = wfMessage( 'revertpage-nouser' );
2886 $summary = wfMessage( 'revertpage' );
2890 // Allow the custom summary to use the same args as the default message
2892 $target->getUserText(), $from, $s->rev_id
,
2893 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
2894 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
2896 if ( $summary instanceof Message
) {
2897 $summary = $summary->params( $args )->inContentLanguage()->text();
2899 $summary = wfMsgReplaceArgs( $summary, $args );
2902 // Trim spaces on user supplied text
2903 $summary = trim( $summary );
2905 // Truncate for whole multibyte characters.
2906 $summary = $wgContLang->truncate( $summary, 255 );
2909 $flags = EDIT_UPDATE
;
2911 if ( $guser->isAllowed( 'minoredit' ) ) {
2912 $flags |
= EDIT_MINOR
;
2915 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
2916 $flags |
= EDIT_FORCE_BOT
;
2919 // Actually store the edit
2920 $status = $this->doEditContent( $target->getContent(), $summary, $flags, $target->getId(), $guser );
2922 if ( !$status->isOK() ) {
2923 return $status->getErrorsArray();
2926 if ( !empty( $status->value
['revision'] ) ) {
2927 $revId = $status->value
['revision']->getId();
2932 wfRunHooks( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
2934 $resultDetails = array(
2935 'summary' => $summary,
2936 'current' => $current,
2937 'target' => $target,
2945 * The onArticle*() functions are supposed to be a kind of hooks
2946 * which should be called whenever any of the specified actions
2949 * This is a good place to put code to clear caches, for instance.
2951 * This is called on page move and undelete, as well as edit
2953 * @param $title Title object
2955 public static function onArticleCreate( $title ) {
2956 // Update existence markers on article/talk tabs...
2957 if ( $title->isTalkPage() ) {
2958 $other = $title->getSubjectPage();
2960 $other = $title->getTalkPage();
2963 $other->invalidateCache();
2964 $other->purgeSquid();
2966 $title->touchLinks();
2967 $title->purgeSquid();
2968 $title->deleteTitleProtection();
2972 * Clears caches when article is deleted
2974 * @param $title Title
2976 public static function onArticleDelete( $title ) {
2977 // Update existence markers on article/talk tabs...
2978 if ( $title->isTalkPage() ) {
2979 $other = $title->getSubjectPage();
2981 $other = $title->getTalkPage();
2984 $other->invalidateCache();
2985 $other->purgeSquid();
2987 $title->touchLinks();
2988 $title->purgeSquid();
2991 HTMLFileCache
::clearFileCache( $title );
2992 InfoAction
::invalidateCache( $title );
2995 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
2996 MessageCache
::singleton()->replace( $title->getDBkey(), false );
3000 if ( $title->getNamespace() == NS_FILE
) {
3001 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
3002 $update->doUpdate();
3006 if ( $title->getNamespace() == NS_USER_TALK
) {
3007 $user = User
::newFromName( $title->getText(), false );
3009 $user->setNewtalk( false );
3014 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3018 * Purge caches on page update etc
3020 * @param $title Title object
3021 * @todo Verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
3023 public static function onArticleEdit( $title ) {
3024 // Invalidate caches of articles which include this page
3025 DeferredUpdates
::addHTMLCacheUpdate( $title, 'templatelinks' );
3027 // Invalidate the caches of all pages which redirect here
3028 DeferredUpdates
::addHTMLCacheUpdate( $title, 'redirect' );
3030 // Purge squid for this page only
3031 $title->purgeSquid();
3033 // Clear file cache for this page only
3034 HTMLFileCache
::clearFileCache( $title );
3035 InfoAction
::invalidateCache( $title );
3041 * Returns a list of categories this page is a member of.
3042 * Results will include hidden categories
3044 * @return TitleArray
3046 public function getCategories() {
3047 $id = $this->getId();
3049 return TitleArray
::newFromResult( new FakeResultWrapper( array() ) );
3052 $dbr = wfGetDB( DB_SLAVE
);
3053 $res = $dbr->select( 'categorylinks',
3054 array( 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ),
3055 // Have to do that since DatabaseBase::fieldNamesWithAlias treats numeric indexes
3056 // as not being aliases, and NS_CATEGORY is numeric
3057 array( 'cl_from' => $id ),
3060 return TitleArray
::newFromResult( $res );
3064 * Returns a list of hidden categories this page is a member of.
3065 * Uses the page_props and categorylinks tables.
3067 * @return Array of Title objects
3069 public function getHiddenCategories() {
3071 $id = $this->getId();
3077 $dbr = wfGetDB( DB_SLAVE
);
3078 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3080 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3081 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
3084 if ( $res !== false ) {
3085 foreach ( $res as $row ) {
3086 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3094 * Return an applicable autosummary if one exists for the given edit.
3095 * @param string|null $oldtext the previous text of the page.
3096 * @param string|null $newtext The submitted text of the page.
3097 * @param int $flags bitmask: a bitmask of flags submitted for the edit.
3098 * @return string An appropriate autosummary, or an empty string.
3100 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3102 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3103 // NOTE: stub for backwards-compatibility. assumes the given text is wikitext. will break horribly if it isn't.
3105 ContentHandler
::deprecated( __METHOD__
, '1.21' );
3107 $handler = ContentHandler
::getForModelID( CONTENT_MODEL_WIKITEXT
);
3108 $oldContent = is_null( $oldtext ) ?
null : $handler->unserializeContent( $oldtext );
3109 $newContent = is_null( $newtext ) ?
null : $handler->unserializeContent( $newtext );
3111 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3115 * Auto-generates a deletion reason
3117 * @param &$hasHistory Boolean: whether the page has a history
3118 * @return mixed String containing deletion reason or empty string, or boolean false
3119 * if no revision occurred
3121 public function getAutoDeleteReason( &$hasHistory ) {
3122 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3126 * Update all the appropriate counts in the category table, given that
3127 * we've added the categories $added and deleted the categories $deleted.
3129 * @param array $added The names of categories that were added
3130 * @param array $deleted The names of categories that were deleted
3132 public function updateCategoryCounts( array $added, array $deleted ) {
3134 $method = __METHOD__
;
3135 $dbw = wfGetDB( DB_MASTER
);
3137 // Do this at the end of the commit to reduce lock wait timeouts
3138 $dbw->onTransactionPreCommitOrIdle(
3139 function() use ( $dbw, $that, $method, $added, $deleted ) {
3140 $ns = $that->getTitle()->getNamespace();
3142 $addFields = array( 'cat_pages = cat_pages + 1' );
3143 $removeFields = array( 'cat_pages = cat_pages - 1' );
3144 if ( $ns == NS_CATEGORY
) {
3145 $addFields[] = 'cat_subcats = cat_subcats + 1';
3146 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3147 } elseif ( $ns == NS_FILE
) {
3148 $addFields[] = 'cat_files = cat_files + 1';
3149 $removeFields[] = 'cat_files = cat_files - 1';
3152 if ( count( $added ) ) {
3153 $insertRows = array();
3154 foreach ( $added as $cat ) {
3155 $insertRows[] = array(
3156 'cat_title' => $cat,
3158 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3159 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3165 array( 'cat_title' ),
3171 if ( count( $deleted ) ) {
3175 array( 'cat_title' => $deleted ),
3180 foreach ( $added as $catName ) {
3181 $cat = Category
::newFromName( $catName );
3182 wfRunHooks( 'CategoryAfterPageAdded', array( $cat, $that ) );
3185 foreach ( $deleted as $catName ) {
3186 $cat = Category
::newFromName( $catName );
3187 wfRunHooks( 'CategoryAfterPageRemoved', array( $cat, $that ) );
3194 * Updates cascading protections
3196 * @param $parserOutput ParserOutput object for the current version
3198 public function doCascadeProtectionUpdates( ParserOutput
$parserOutput ) {
3199 if ( wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
3203 // templatelinks table may have become out of sync,
3204 // especially if using variable-based transclusions.
3205 // For paranoia, check if things have changed and if
3206 // so apply updates to the database. This will ensure
3207 // that cascaded protections apply as soon as the changes
3210 // Get templates from templatelinks
3211 $id = $this->getId();
3213 $tlTemplates = array();
3215 $dbr = wfGetDB( DB_SLAVE
);
3216 $res = $dbr->select( array( 'templatelinks' ),
3217 array( 'tl_namespace', 'tl_title' ),
3218 array( 'tl_from' => $id ),
3222 foreach ( $res as $row ) {
3223 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
3226 // Get templates from parser output.
3227 $poTemplates = array();
3228 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
3229 foreach ( $templates as $dbk => $id ) {
3230 $poTemplates["$ns:$dbk"] = true;
3235 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
3237 if ( count( $templates_diff ) > 0 ) {
3238 // Whee, link updates time.
3239 // Note: we are only interested in links here. We don't need to get other DataUpdate items from the parser output.
3240 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
3246 * Return a list of templates used by this article.
3247 * Uses the templatelinks table
3249 * @deprecated in 1.19; use Title::getTemplateLinksFrom()
3250 * @return Array of Title objects
3252 public function getUsedTemplates() {
3253 return $this->mTitle
->getTemplateLinksFrom();
3257 * Perform article updates on a special page creation.
3259 * @param $rev Revision object
3261 * @todo This is a shitty interface function. Kill it and replace the
3262 * other shitty functions like doEditUpdates and such so it's not needed
3264 * @deprecated since 1.18, use doEditUpdates()
3266 public function createUpdates( $rev ) {
3267 wfDeprecated( __METHOD__
, '1.18' );
3269 $this->doEditUpdates( $rev, $wgUser, array( 'created' => true ) );
3273 * This function is called right before saving the wikitext,
3274 * so we can do things like signatures and links-in-context.
3276 * @deprecated in 1.19; use Parser::preSaveTransform() instead
3277 * @param string $text article contents
3278 * @param $user User object: user doing the edit
3279 * @param $popts ParserOptions object: parser options, default options for
3280 * the user loaded if null given
3281 * @return string article contents with altered wikitext markup (signatures
3282 * converted, {{subst:}}, templates, etc.)
3284 public function preSaveTransform( $text, User
$user = null, ParserOptions
$popts = null ) {
3285 global $wgParser, $wgUser;
3287 wfDeprecated( __METHOD__
, '1.19' );
3289 $user = is_null( $user ) ?
$wgUser : $user;
3291 if ( $popts === null ) {
3292 $popts = ParserOptions
::newFromUser( $user );
3295 return $wgParser->preSaveTransform( $text, $this->mTitle
, $user, $popts );
3299 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
3301 * @deprecated in 1.19; use Title::isBigDeletion() instead.
3304 public function isBigDeletion() {
3305 wfDeprecated( __METHOD__
, '1.19' );
3306 return $this->mTitle
->isBigDeletion();
3310 * Get the approximate revision count of this page.
3312 * @deprecated in 1.19; use Title::estimateRevisionCount() instead.
3315 public function estimateRevisionCount() {
3316 wfDeprecated( __METHOD__
, '1.19' );
3317 return $this->mTitle
->estimateRevisionCount();
3321 * Update the article's restriction field, and leave a log entry.
3323 * @deprecated since 1.19
3324 * @param array $limit set of restriction keys
3325 * @param $reason String
3326 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
3327 * @param array $expiry per restriction type expiration
3328 * @param $user User The user updating the restrictions
3329 * @return bool true on success
3331 public function updateRestrictions(
3332 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User
$user = null
3336 $user = is_null( $user ) ?
$wgUser : $user;
3338 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
3342 * @deprecated since 1.18
3344 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3345 wfDeprecated( __METHOD__
, '1.18' );
3347 $this->doQuickEdit( $text, $wgUser, $comment, $minor );
3351 * @deprecated since 1.18
3353 public function viewUpdates() {
3354 wfDeprecated( __METHOD__
, '1.18' );
3356 return $this->doViewUpdates( $wgUser );
3360 * @deprecated since 1.18
3364 public function useParserCache( $oldid ) {
3365 wfDeprecated( __METHOD__
, '1.18' );
3367 return $this->isParserCacheUsed( ParserOptions
::newFromUser( $wgUser ), $oldid );
3371 * Returns a list of updates to be performed when this page is deleted. The updates should remove any information
3372 * about this page from secondary data stores such as links tables.
3374 * @param Content|null $content optional Content object for determining the necessary updates
3375 * @return Array an array of DataUpdates objects
3377 public function getDeletionUpdates( Content
$content = null ) {
3379 // load content object, which may be used to determine the necessary updates
3380 // XXX: the content may not be needed to determine the updates, then this would be overhead.
3381 $content = $this->getContent( Revision
::RAW
);
3387 $updates = $content->getDeletionUpdates( $this );
3390 wfRunHooks( 'WikiPageDeletionUpdates', array( $this, $content, &$updates ) );
3396 class PoolWorkArticleView
extends PoolCounterWork
{
3414 * @var ParserOptions
3416 private $parserOptions;
3421 private $content = null;
3424 * @var ParserOutput|bool
3426 private $parserOutput = false;
3431 private $isDirty = false;
3436 private $error = false;
3442 * @param $revid Integer: ID of the revision being parsed
3443 * @param $useParserCache Boolean: whether to use the parser cache
3444 * @param $parserOptions parserOptions to use for the parse operation
3445 * @param $content Content|String: content to parse or null to load it; may also be given as a wikitext string, for BC
3447 function __construct( Page
$page, ParserOptions
$parserOptions, $revid, $useParserCache, $content = null ) {
3448 if ( is_string( $content ) ) { // BC: old style call
3449 $modelId = $page->getRevision()->getContentModel();
3450 $format = $page->getRevision()->getContentFormat();
3451 $content = ContentHandler
::makeContent( $content, $page->getTitle(), $modelId, $format );
3454 $this->page
= $page;
3455 $this->revid
= $revid;
3456 $this->cacheable
= $useParserCache;
3457 $this->parserOptions
= $parserOptions;
3458 $this->content
= $content;
3459 $this->cacheKey
= ParserCache
::singleton()->getKey( $page, $parserOptions );
3460 parent
::__construct( 'ArticleView', $this->cacheKey
. ':revid:' . $revid );
3464 * Get the ParserOutput from this object, or false in case of failure
3466 * @return ParserOutput
3468 public function getParserOutput() {
3469 return $this->parserOutput
;
3473 * Get whether the ParserOutput is a dirty one (i.e. expired)
3477 public function getIsDirty() {
3478 return $this->isDirty
;
3482 * Get a Status object in case of error or false otherwise
3484 * @return Status|bool
3486 public function getError() {
3487 return $this->error
;
3494 global $wgUseFileCache;
3496 // @todo several of the methods called on $this->page are not declared in Page, but present
3497 // in WikiPage and delegated by Article.
3499 $isCurrent = $this->revid
=== $this->page
->getLatest();
3501 if ( $this->content
!== null ) {
3502 $content = $this->content
;
3503 } elseif ( $isCurrent ) {
3504 // XXX: why use RAW audience here, and PUBLIC (default) below?
3505 $content = $this->page
->getContent( Revision
::RAW
);
3507 $rev = Revision
::newFromTitle( $this->page
->getTitle(), $this->revid
);
3509 if ( $rev === null ) {
3512 // XXX: why use PUBLIC audience here (default), and RAW above?
3513 $content = $rev->getContent();
3517 if ( $content === null ) {
3521 // Reduce effects of race conditions for slow parses (bug 46014)
3522 $cacheTime = wfTimestampNow();
3524 $time = - microtime( true );
3525 $this->parserOutput
= $content->getParserOutput( $this->page
->getTitle(), $this->revid
, $this->parserOptions
);
3526 $time +
= microtime( true );
3530 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
3531 $this->page
->getTitle()->getPrefixedDBkey() ) );
3534 if ( $this->cacheable
&& $this->parserOutput
->isCacheable() ) {
3535 ParserCache
::singleton()->save(
3536 $this->parserOutput
, $this->page
, $this->parserOptions
, $cacheTime );
3539 // Make sure file cache is not used on uncacheable content.
3540 // Output that has magic words in it can still use the parser cache
3541 // (if enabled), though it will generally expire sooner.
3542 if ( !$this->parserOutput
->isCacheable() ||
$this->parserOutput
->containsOldMagic() ) {
3543 $wgUseFileCache = false;
3547 $this->page
->doCascadeProtectionUpdates( $this->parserOutput
);
3556 function getCachedWork() {
3557 $this->parserOutput
= ParserCache
::singleton()->get( $this->page
, $this->parserOptions
);
3559 if ( $this->parserOutput
=== false ) {
3560 wfDebug( __METHOD__
. ": parser cache miss\n" );
3563 wfDebug( __METHOD__
. ": parser cache hit\n" );
3571 function fallback() {
3572 $this->parserOutput
= ParserCache
::singleton()->getDirty( $this->page
, $this->parserOptions
);
3574 if ( $this->parserOutput
=== false ) {
3575 wfDebugLog( 'dirty', "dirty missing\n" );
3576 wfDebug( __METHOD__
. ": no dirty cache\n" );
3579 wfDebug( __METHOD__
. ": sending dirty output\n" );
3580 wfDebugLog( 'dirty', "dirty output {$this->cacheKey}\n" );
3581 $this->isDirty
= true;
3587 * @param $status Status
3590 function error( $status ) {
3591 $this->error
= $status;